PBDTGetInfoAsync

PBDTGetInfoAsync
Header:	Files.h		Carbon status:	Supported

Determines the parent directory and the amount of space used by the desktop database on a particular volume. This function runs asynchronously.

OSErr PBDTGetInfoAsync (
    DTPBPtr paramBlock
);

paramBlock: A pointer to a desktop parameter block.

function result: A result code.

DISCUSSION

Clear all fields (other than input fields) in the parameter block that you pass to Desktop Manager functions. The relevant fields of the parameter block for this function are:

ioCompletionOn input, a universal procedure pointer to a completion function. A value of type IOCompletionUPP.
ioResultOn return, the result code of the function. A value of type OSErr.
ioVRefNumOn return, the volume reference number where the database files are actually stored. A value of type SInt16.
ioDTRefNumOn input, the desktop database reference number of the database which you wish to obtain information about. A value of type SInt16.
ioIndexOn return, the number of files comprising the desktop database on the volume. A value of type SInt16.
ioDirIDOn return, the parent directory of the desktop database. A value of type SInt32.
ioDTLgLenOn return, the logical length of the database files (the sum of the logical lengths of the files that constitute the desktop database for a given volume). A value of type SInt32.
ioDTPyLenOn return, the physical length of the database files (the sum of the physical lengths of the files that constitute the desktop database for a given volume). A value of type SInt32.

SPECIAL CONSIDERATIONS

All of the Desktop Manager functions may move or purge memory blocks in the application heap or for some other reason should not be called from within an interrupt. Your application should not call Desktop Manager functions at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.